Celestin Apprentice 5

home *** CD-ROM | disk | FTP | other *** search

/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / C / Applications / MacTide 1.3.3 / README < prev next >

Wrap

Text File | 1995-12-28 | 37.0 KB | 941 lines | [TEXT/MPS ]

XTide Harmonic tide clock and tide predictor Version 1.3.3 12/5/95 Copyright (C) 1995 David Flater. Also starring: Jef Poskanzer; Jack Greenbaum; Rob Miracle; Geoff Kuenning; Dale DePriest. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. The tide prediction algorithm used in this program was developed with United States Government funding, so no proprietary rights can be attached to it. For more information, refer to the following publications: Manual of Harmonic Analysis and Prediction of Tides. Special Publication No. 98, Revised (1940) Edition. United States Government Printing Office, 1941. Computer Applications to Tides in the National Ocean Survey. Supplement to Manual of Harmonic Analysis and Prediction of Tides (Special Publication No. 98). National Ocean Service, National Oceanic and Atmospheric Administration, U.S. Department of Commerce, January 1982. THIS PACKAGE IS AVAILABLE FOR ANONYMOUS FTP FROM: ftp://speckle.ncsl.nist.gov/flater/sources/xtide-1.3.3.tgz (The version number may change.) An illustrated, HTML-ized version of this README is available at: http://case50.ncsl.nist.gov/xtide/xtide.html Overview -------- Xtide was originally intended to be a "tide clock." Lots of people down on the shore have them -- it's just an analog clock that's been marked with high and low tide, that makes a complete cycle in a bit over 12 hours. There's just one minor problem with them, which is that they are only accurate to within plus or minus 50% of reality. I felt kind of stupid having a square thingy on my screen that just went up and down and paid no attention to the actual water level outside. Xtide is now a bit more accurate than that, but there's a cost associated: you need to (somehow) get the harmonic constants for your location. This is a set of numbers that tells Xtide everything it needs to know to predict your local tides. More will be said about this below. Xtide has three basic modes of operation: clock mode, graph mode, and text mode. Clock mode has "simple" and "hairy" sub-modes; graph mode has three sub-modes, one for each type of output it can generate (X, PPM, or ASCII); text mode has "regular," "calendar," and "banner" sub-modes. The default mode is clock mode. The program Tide is a stripped down interface to XTide that can compile without the X11 libraries. It only supports text, PPM, and ASCII graph output. By default, all timestamps are displayed in your local time zone. The exact appearance of timestamps on the screen will vary depending on the mode. You can use the -utc switch to change the time zone to UTC, or specify an offset from UTC with the -tz switch. If you are feeling lucky, the -loctz switch will try to get the time zone of the location being displayed. -loctz is fragile, especially on System V machines where it is likely to yield incorrect results on any location outside the U.S. The tick marks on the horizontal axis of a tide graph are one hour apart. The other tick marks are whatever units of depth were used for the amplitudes for the location being shown. They are calibrated with the mean lower low water datum, or whatever datum was given in the harmonics file (possibly some other mean low water variant or even mean sea level). Starting with version 1.1, the matching of location names specified with -location is case-insensitive, and you only have to specify enough letters to uniquely identify the location that you want. Clock Mode ---------- The tide clock shows the current water level and the predicted times of the next high and low tides. The water is blue if it is flowing, green if it is ebbing. You can change the colors with command line switches (-fgrise, -fgfall). The -skinny option allows the window to be more narrow by abbreviating timestamps to four digits, in military time. "7:28 PM EDT" becomes simply "1928". -skinny will cause similar changes in the timestamps displayed in graph mode and text mode. The -hairy option causes the tide clock to track the tide curve instead of simply showing the current water level. The -gstretch option can be used with -hairy to control the aspect ratio of the graphing. Values greater than 1 stretch it out, while values between 0 and 1 scrunch it up. If you don't specify -calib or -tinc, the hour marks will be calibrated with the current time (marking one hour from now, one hour ago, etc.). -calib causes the hour marks to be calibrated with the top of the hour. -tinc causes the hour marks to be calibrated and also labels them. If you don't specify an increment, every hour is labeled. The -now option causes the current time to be displayed in the tide clock. This is handy if the tide clock is set to a different time zone and you want to know what time it is over there. It may also alleviate the need for a separate xclock. -hinc causes the depth marks to be labeled. If you don't specify an increment, XTide will choose one that is reasonable. -mark, -middle, and -mllw draw lines at various depth levels that may be of interest to you. Graph Mode ---------- Graph mode, triggered with the -graph switch, draws a graph of the water level for two days and labels the high and low tides. By using -gstart with -graph, you can predict tides far into the future. The -gstart time spec is in your local time zone; this does not change if you specify -utc or -tz, but may be affected by -loctz. Close the window or kill the program to get rid of the graph. The -mark switch, in addition to drawing a horizontal line at the water level you specify, causes the times of rising and falling transitions of that line to be displayed. The -now switch causes a cross to be drawn on the graph to indicate the current time, and the graph to be centered around the current time if not overridden by -gstart. Normally the graph only shows from the current time onward. -tinc is still used to label the hour ticks in graph mode as it was in clock mode. However, -calib is not needed in graph mode (the hour ticks are always calibrated with the top of the hour). -hinc is enabled by default for graphs, but you can still use -hinc to change the increment used for labeling the depth marks. The -ppm switch invokes an alternative graph mode that sends output to a PPM file instead of the X server. You do not need to specify both -ppm and -graph. The output from -ppm will look better than the output of -graph since the tide curve will be anti-aliased; however, the switches for changing the colors require you to use the syntax rgb:hh/hh/hh (where hh is a 2-digit hexadecimal number). The dimensions can be specified with -geometry NxN. (Previously it was necessary to use -ppmgeom instead of -geometry; -ppmgeom is still supported for compatibility.) If you specify -text with -graph, you will get ASCII graph mode. This produces a best-effort rendition of the tide graph for a TTY: Baltimore (Fort McHenry) [ | 09-07 09-07 | 09-08 09-08 | 09-09 09-09 ] [ | 0607 1823 | 0655 1916 | 0738 2006 ] [ | | | ]2.6 [ | | | ]2.2 [ | **** | **** | *** ** ]1.9 [ | ****** **** | ****** ***** | ****** *****]1.5 [ | ********* ******* | ******** *******| ******** ******]1.2 [ | *********** *********| ********** ********* ********** *******]0.8 [*************************************************************************]0.5 [*************************************************************************]0.1 [*************************************************************************]-0.2 [*************************************************************************]-0.6 [9-06 09-07 09-08 09-08 09-09 09-09 ] [324 1236 0024 1317 0120 1356 ] The -gstretch option lets you adjust how stretched out / crowded the graph is. -gstretch 2.0 means that graph mode will stretch one day across the screen instead of two. -gstretch 0.5 crowds four days in the same amount of space. The -gstretch option may help you to read the high and low tide predictions if they were too close together on the graph. You can also use the -skinny option along with -graph to get condensed timestamps that won't overlap as much. If all else fails, use text mode. Text Mode --------- Text mode, invoked with the -text switch, causes high and low tides, and rising and falling transitions of the -mark level if one is specified, to be listed to standard output: Baltimore (Fort McHenry) Mark level: 2.000000 Rising: 1995-09-06 4:41 AM EDT 2.00 High Tide: 1995-09-06 5:16 AM EDT 2.03 Falling: 1995-09-06 5:52 AM EDT 2.00 Low Tide: 1995-09-06 11:51 AM EDT 0.68 High Tide: 1995-09-06 5:26 PM EDT 1.50 The floating point number at the end of the line is the tide height at the time of the high or low tide. The -text switch takes an optional numeric argument to specify how many lines of output to generate, not including the header stuff. The -gstart switch can be used to specify the starting time for -text, -calen, or -banner. The -calen switch causes one month of tides to be formatted like a calendar. Here is what one week looks like: Sunday Monday Tuesda Wednes Thursd Friday Saturday 10-01 10-02 10-03 10-04 10-05 10-06 10-07 H0045 H0149 H0254 H0356 H0453 H0545 L0024 1.92 1.89 1.85 1.81 1.76 1.70 0.47 L0724 L0831 L0934 L1030 L1119 L1203 H0631 0.73 0.71 0.66 0.59 0.53 0.46 1.63 H1234 H1349 H1506 H1617 H1719 H1814 L1243 1.29 1.28 1.33 1.42 1.53 1.64 0.41 L1841 L1952 L2106 L2218 L2324 H1903 0.40 0.44 0.47 0.48 0.47 1.73 "High Tide" and "Low Tide" are abbreviated to the single letters "H" and "L" prefixed to the timestamps. The -banner switch produces a sideways ASCII tide graph, which is mainly for sending to dot matrix printers that use continuous printer paper. The length of the output is controlled by -text, and the aspect ratio is controlled by -gstretch. Something for Everyone ---------------------- Additional command line switches are shown in the usage info: Usage: xtide [-banner] Sideways ASCII tide graph [-bg ...] Background color [-calen] Make 1 month tide calendar (slow) [-calib] (Hairy) Tick marks at top of the hour [-check YYYY] Check for errors in equilibrium arguments [-config {filename | -}] Read configuration file / stdin [-cur] Restrict -location search to currents [-display ...] X display [-fgfall ...] Color of ebbing water [-fgmark ...] Color of mark line [-fgmiddle ...] Color of middle line [-fgmllw ...] Color of mllw line [-fgrise ...] Color of flooding water [-fgtext ...] Color of text and lines [-geometry ...] X or PPM geometry [-graph] Graph 2 days of tides (modulo gstretch) [-gstart YYYY:MM:DD:HH:MM] Time at which to start graph or text [-gstretch N.NN] Adjust graph detail vs. time span [-hairy] Show slice of tide graph in the clock [-hfile ...] Location and name of harmonics file [-hinc [N]] Label depth marks in increments of N [-hloff [-]N.NN] (Text) Tide level offset for high tide [-htoff [-]HH:MM] (Text) Time offset for high tide [-list] List all locations in harmonics file [-listtz] List with meridians and time zone info [-lloff [-]N.NN] (Text) Tide level offset for low tide [-location "Name"] Location to show tides for [-loctz] Try to use time zone of location (Moof!) [-ltoff [-]HH:MM] (Text) Time offset for low tide [-mark [-]N.NN] Draw line at specified tide level [-middle] Draw line near mean tide level [-mllw] Draw line at mean lower low water level [-nolines] Suppress tick marks / depth lines [-now] Show current time / mark place on graph [-ppm {filename | -}] Write graph as PPM to file / stdout [-skinny] Trim the fat, make window tall and skinny [-test] Test mode (mostly useless) [-text [N]] List N tides / select ASCII graph mode [-tinc [N]] Label each N hours [-toplines] (Graph) Depth lines on top of graph [-tz [-]HH:MM] Fixed time zone offset for timestamps [-utc] Show timestamps in UTC [-version] Print XTide version Time format example -- half past midnight, June 1, 1995: 1995:06:01:00:30 In PPM mode, colors must be specified as rgb:hh/hh/hh (where hh is a 2-digit hexadecimal number) and geometry must be specified as NxN. Usage: tide [-banner] Sideways ASCII tide graph [-bg color] Background color [-calen] Make 1 month tide calendar (slow) [-check YYYY] Check for errors in equilibrium arguments [-config {filename | -}] Read configuration file / stdin [-cur] Restrict -location search to currents [-fgfall color] Color of ebb current [-fgmark color] Color of mark line [-fgmiddle color] Color of middle line [-fgmllw color] Color of mllw line [-fgrise color] Color of normal graph / flood current [-fgtext color] Color of text and lines [-geometry NxN] PPM geometry [-graph] ASCII graph mode [-gstart YYYY:MM:DD:HH:MM] Time at which to start [-gstretch N.NN] Adjust graph detail vs. time span [-hfile ...] Location and name of harmonics file [-hinc [N]] Label depth marks in increments of N [-hloff [-]N.NN] (Text) Tide level offset for high tide [-htoff [-]HH:MM] (Text) Time offset for high tide [-list] List all locations in harmonics file [-listtz] List with meridians and time zone info [-lloff [-]N.NN] (Text) Tide level offset for low tide [-location "Name"] Location to show tides for [-loctz] Try to use time zone of location (Moof!) [-ltoff [-]HH:MM] (Text) Time offset for low tide [-mark [-]N.NN] Draw line at specified tide level [-middle] Draw line near mean tide level [-mllw] Draw line at mean lower low water level [-nolines] Suppress tick marks / depth lines [-now] Mark current time on graph [-ppm {filename | -}] Write graph as PPM to file / stdout [-skinny] Abbreviate timestamps [-text N] List N tides to standard output [-tinc [N]] Label each N hours [-toplines] (PPM) Depth lines on top of graph [-tz [-]HH:MM] Fixed time zone offset for timestamps [-utc] Show timestamps in UTC [-version] Print Tide version Time format example -- half past midnight, June 1, 1995: 1995:06:01:00:30 Colors must be specified as rgb:hh/hh/hh (where hh is a 2-digit hexadecimal number) You NEED Harmonic Constants --------------------------- You cannot predict tides for your locale unless you know its harmonic constants. A database of harmonic constants is kept in the harmonics file. The most recent version of the harmonics file is available for anonymous FTP at ftp://speckle.ncsl.nist.gov/flater/sources/harmonics.gz. (Footnote: The file 'harmonics' in the same directory is the old one, for versions 1.1.1 and older; it will eventually be deleted.) FTP it and gunzip it. As of 9/10/95, there are approximately 220 locations supported. If your location is not among those already in the harmonics file, then getting constants for your location could be a real pain. You can do what I did, and pay the National Ocean Service (in the U.S.) ten dollars for one set of constants. Otherwise, lots of luck. If you do go through the trouble, and the data that you get can be freely distributed, please send it to me so that I can add it to the end of the harmonics file that I distribute. If enough people do this, I might actually assemble a halfway decent database. If you send me a set of constants, be sure to preface it with comment lines giving your name, your e-mail address, where you got the data, how old the data is, and the units used for amplitude. The age of the data is significant not only because geographical changes can invalidate a set of constants, but because the NOS changed which datum they used for many locations in 1989. The National Ocean Service and Similar Non-U.S. Organizations ------------------------------------------------------------- The quickest way to get harmonic constants from the NOS is to fax a request to 301-713-4436 asking for the 37 constituents for someplace at or near XYZ. Provide your snail mail address. They will mail you a bill at the same time that they mail the data. It will be one or two weeks before you get it. You can call 301-713-2877 if you want to try to check on its progress. There are a number of organizations world wide that are capable of providing harmonic constants. I know little about them except that they exist, and that the system of 37 constituents used by the NOS is not used by all of them. The harmonics file that I provided is set up for the NOS system. Given sufficient information, you should be able to modify the harmonics file to use whatever system is used by your favorite organization. I cannot currently provide harmonics files to work with every possible system, since I don't know anything about any of them except the one used by the NOS. However, if you construct a harmonics file for a different system, please send it to me with a description of whose system it implements, and I will gladly add it to this distribution. I will also include here any information that is sent to me to help other people get harmonic constants from different organizations. Getting Harmonic Constants from your Back Yard ---------------------------------------------- If you are ambitious and have access to regular water level readings for your locale over the course of, oh, a YEAR or so, you can derive the harmonic constants yourself. I will be just as happy to distribute sets of harmonic constants that you derive; see above for how to send them to me. At the moment we do not have a working program for deriving harmonic constants, but Dean Pentcheff (dean@tbone.biol.sc.edu) is looking at porting the source code given in Computer Applications to Tides in the National Ocean Survey. That publication can be gotten from the NOS by faxing a request to the same number as provided above for harmonic constants. It costs ten dollars. The Harmonics File ------------------ An incompatible change to the format of the harmonics file was made with version 1.2 of XTide. Earlier versions will no longer work. The change was to add a field for the DATUM so that "absolute" tide heights can be calculated. The harmonics file contains definitions for the 37 constituents used by the NOS and whatever meager database of harmonic constants I have managed to collect. The data that must be entered for each location are described in the comments: # Harmonic constants for all locations that we can predict tides for. # First line: name of location. # Second line: time meridian [whitespace] tzfile. # Third line: DATUM. # Remaining lines: identifier [whitespace] amplitude [whitespace] epoch. # The DATUM is the mean lower low water, or equivalent number for # calculating the absolute tide height. # The time meridian takes the format [-]HH:MM and is hours east of # Greenwich. This is your time zone displacement in the _winter_. Do # not include Daylight Savings Time! # The tzfile is a reference to a file in the zoneinfo directory as # described in the man page for tzset on BSD machines. You may omit # this if you have no idea, but the -loctz switch won't work for that # location. # Amplitude units do not matter; they will not be converted. # Epoch is "modified" or "adapted" epoch in degrees, also known as # Kappa Prime. # The identifiers are for readability only; xtide assumes that they # are in the same order as defined above. On the newest NOS printout, the columns you want to enter are labeled H (amplitude) and Kappa Prime (modified epoch). My printout doesn't have mean lower low water, so I used MSL (Mean Sea Level) for the DATUM. If you get MLLW, then use it. On the old Form 444, you want to enter the values from column H (amplitude) and the _negations_ of the values in column D (-k'). The DATUM is listed off to the right (in the remarks section) on the line marked A0; right below that it tells you whether it's mean lower low water, or what. It tells you what your meridian is at the top of that section -- but you have to negate that too. Unless there is some major incompatibility, you should be able to modify the harmonics file to use a different method to calculate tides, with more or less constituents (like the 114-constituent system for Anchorage, or the system used by a data service other than NOS). However, it is assumed that all sets of harmonic constants in a given harmonics file are on the same system, so you will have to specify a different harmonics file on the command line if you want to do multiple locations with different tide prediction methods. What About Currents? -------------------- XTide can do simple reversing currents, because the math required to do them is identical to the math for predicting tides. If a location in the harmonics file has the word "Current" in its name, then XTide assumes that it is a data set for predicting currents instead of tides, and tries to generate output that is more appropriate to currents. The following things are different for currents: 1. Units change from length to velocity. 2. MLLW is replaced by the velocity of the permanent current. 3. The -mark mechanism is hardwired to find Slack Water (0 current). 4. Captions change from "High Tide" to "Max Flood," etc. 5. Graphical output is modified to show values as being above and below Slack Water instead of originating from the bottom of the window. 6. Many tide-specific switches will generate meaningless results. Installation ------------ If you just want to see what the program looks like, you can skip step 1. Non-ANSI compilers need not apply. 1. You NEED the harmonic constants for your location. I will keep an updated harmonics file available for anonymous FTP at ftp://speckle.ncsl.nist.gov/flater/sources/harmonics.gz. If your location is not in it, read the previous sections to find out what to do about it. 2. Edit the #defines in config.h to specify the location and name of the harmonics file that you will use and the default location to show tides for. The location that you specify must be in the harmonics file. NOTE: The environment variables LOCATION and HFILE override the values specified in config.h. 3. Copy the harmonics file to the place that you have decided to put it and chmod 644. IF YOU HAVE X LIBRARIES: 4. xmkmf; make depend; make. 5. Copy the xtide executable into /usr/X11R6/bin or whatever. IF YOU DON'T HAVE X LIBRARIES: 4. Copy Makefile.tide to Makefile and edit as desired. 5. make. 6. Copy the tide executable into /usr/local/bin or whatever. 7. Copy xtide.man to /usr/man/man1/xtide.1 and chmod 644. OS/2 Installation ----------------- (Ported by Dale DePriest) Tide now includes support for OS2. This port has been specifically tested using the gcc/emx version 0.9a. Xtide could also be ported if you have a copy of the X libraries. To build your copy of tide: 1. copy makefile.os2 to Makefile 2. run nmake or make. EMX does not support Daylight savings time so it is probably best to run tide with the -tz option. For PDT use -tz -7:0. For standard times you can set the environmental variable TZ or EMXTZ. An example would be 'set TZ = PST8PDT'. The -loctz switch might do this for you. AIX and HP-UX Installation -------------------------- (Ported by Dale DePriest) When compiling on these platforms, use the following compiler switches: AIX: CC = c89 -DAIX -D_XOPEN_SOURCE HP-UX: CC = c89 -D_XOPEN_SOURCE Configuration Files ------------------- Config files are strictly optional. They are a convenience feature. There is nothing you can do in config files that you can't do on the command line. However, if you are making a web interface to XTide, it is probably a lot safer to pipe in arguments with -config - than to put them on the command line. XTide (Tide) will attempt to read config files in the following order: 1. Any and all config files specified with the -config switch. 2. The config file specified in the environment variable XTIDERC (TIDERC). 3. ~/.xtiderc (~/.tiderc). The environment variable HOME must be set for this to work. 4. The system config file specified by the xsysconfig (sysconfig) #define in config.h. Only one config file will be read, except if the -config switch is used multiple times. Config files take effect before the command line is processed except for those specified with -config, which take effect at the place that -config occurs in the command line. The format of a config file is just like the command line, except that you can't do anything fancy. Arguments can be delimited with double quotes, and # causes the rest of the line to be interpreted as comments. # Here is an example config file -loctz -location "Wherever I May Roam" -fgrise uglybrown # Ugly brown is actually quite pretty Bugs ---- 1. The node factors and epoch are changed abruptly at the stroke of midnight on New Year's Eve GMT. This causes a slight discontinuity which may cause spurious high and low tide predictions. As a corollary, on a graph spanning two years, the depth lines will be wrong for one year or the other -- unless you figure out the secret to making it display _both_ sets of lines! 2. Because of the slackful matching used to find data sets in the harmonics file, if one data set has a name that is a prefix of the name of a second data set, such as "San Francisco" and "San Francisco Current", then the first data set must appear earlier in the harmonics file, or it will not be selectable. (Typing "San Francisco" would get you "San Francisco Current".) 3. The -loctz switch probably will never work perfectly on any flavor of Unix. XTide FAQ --------- Q: "First it says high tide is at 3:15 PM but then when I run it again it says 3:14 PM!" A: Xtide's accuracy is plus or minus one minute. The behavior that you witnessed is normal. Q: "The -skinny option doesn't make it much skinnier...." A: It's your window manager. Some window managers won't let windows go outside of a certain aspect ratio; some won't let a window get smaller than is needed to display all the buttons in its title bar. Q: "The tides for my location are totally wrong!" A: Try negating all the epoch values for your location in the harmonics file. If it works, tell me about it so I can make the change permanent. Sign inversion is a ubiquitous problem for sets of harmonic constants, and there's no way for me to know when it's wrong unless somebody with access to reliable tide tables for that location tells me so. Q: "Has this been ported to Windows / OS/2 / anything but Unix?" A: Only a little bit. The TTY-only client now compiles under OS/2 thanks to Dale DePriest; Eric Lyons (lyons@nbn.com) said that it already compiles under Windows NT. Eric has indicated that he may port XTide to Windows. Q: "So is there a Mac version?" A: NO! Q: "I know that you said that -loctz is fragile, but it's not even working for U.S. locations." A: Try adding -DBROKEN_ZONEINFO to the compile switches. If it helps, and you can send me a predefined identifier for your OS (like #ifdef OS2), then I'll make it so that BROKEN_ZONEINFO will be defined automatically on your OS. Acknowledgements ---------------- Thanks to Greg Seidman (anthro@cs.umd.edu) for suggesting many of the features that appeared in version 1. Thanks to Frank Smith (frank@nwra.com) for supplying data and putting up with my confused e-mail during the stressful debugging of 1.0.1. Thanks to Karl Hahn (hahn@lds.loral.com) for supplying a huge number of harmonic constants. Thanks to Dale DePriest (daled@cadence.com) for suggesting many new features, beta testing, and porting to several flavorful operating systems. Thanks to Dean Pentcheff (dean@tbone.biol.sc.edu) for beta testing, suggesting features, supplying many data sets, and generally being very active in promoting XTide. Thanks to Jef Poskanzer (jef@ee.lbl.gov) for much coding, suggesting of features, and beta testing. Thanks to Jack Greenbaum (jackg@crc.ricoh.com) for coding, suggesting features, beta testing, and doing the homework to get prediction of currents figured out. Thanks to Rob Miracle (rwm@mpgn.com) for the Ultrix compatibility patch. Thanks to Georg Vollmers (georg@egalize.han.de), Tom Varga (tvarga@lsil.com), and Bob Kenney (rmk@unh.edu) for suggesting new features. Thanks to Andrew Davidson (andrew.davidson@eng.sun.com) for helping with Solaris compatibility. Thanks to Geoff Kuenning (geoff@ficus.cs.ucla.edu) for the SunOS patch. Thanks to Jeff Small (jeff@cjsa.com) for suggesting features and writing the man page. Contact Info ------------ David Flater dave@case50.ncsl.nist.gov Changelog --------- Patch 3 to 1.3, 12/5/95: Closest matching color code forgot to allocate the color once it found it. Patch 2 to 1.3, 12/4/95: Updated BROKEN_ZONEINFO code to add a few more time zones. Cleaned up binary garbage left in the time zone spec by some time zone files. Patch 1 to 1.3, 11/29/95: Fixed negative X and Y specs in X geometries. Added code to substitute the closest available color instead of barfing when color map is full. Updated the text of some error messages to be more accurate. Version 1.3, 10/31/95: Added -hinc and -tinc. Turned on vertical labeling by default in graph and PPM, with best-guess increments. Environment variables LOCATION and HFILE now override config.h. Integrated OS/2 patch from Dale DePriest. -version now stops the show. Print more illuminating error message when color map is full. Support config files. Added -loctz. Support currents. Made -loctz work some of the time under IRIX. Added -cur. Support comments in config files. Support -tinc in hairy mode. Cleaned up more Solaris compiler warnings. AIX and HP compatibility courtesy of Dale DePriest. Never-ending maintenance on BROKEN_ZONEINFO code. Changed "line discipline" for ASCII graph mode. Fixed a potential segmentation violation when mark lines aren't in the visible range on the graph. Allow changing colors in PPM mode; made -geometry work in PPM mode too. Added -toplines. -now works with -graph and -ppm to center the graph around the current time and mark it on the graph. Harmonized color syntax for PPM mode with X color syntax. Expanded the workable range in graph mode (for Deception Pass). Fixed some stupid typos. Added some friendly error messages. -hinc now defaults to a reasonable value instead of always 1. Added -calen. Minor cleanups. Made font spec more specific to fix portability problem. Print out location name and mark level at top of all text modes. Fixed BROKEN_ZONEINFO again. Added -banner. Don't display mark setting for currents since it's always 0. Changed prev_day, increment_day to be more robust with DST changes. Go for one more hour when drawing hour ticks so that -tinc will draw partial digits in a symmetrical manner. Dynamically allocate memory for -calen instead of static. Go for one more hour on day marks too. Patch 3 to 1.2, 9/12/95: Again fixed the problem with tides changing out of synch with the water color in the tide clock. Patch 2 to 1.2, 9/11/95: Geoff Kuenning (geoff@ficus.cs.ucla.edu) sent a patch to work around a broken assert macro on SunOS 4.1.1. Patch 1 to 1.2, 9/11/95: Accept either SVR4 or __svr4__ to avoid using the old SunOs code under Solaris. Default location of harmonics file if you don't change config.h is now current directory. Version 1.2, 9/10/95: Jef split xtide.c into xtide.c, tide.c, and tidelib.c to allow people without X libraries to compile a text-only client. Tide levels reported in text mode are now adjusted to mean lower low water, or whatever tide datum has been provided. An incompatible change to the format of the harmonics file was made to support this. Added -hloff, -htoff, -lloff, -ltoff, and -mark. Put mark and middle lines on top of the graph. Made them red. Jack made the title of the graph different from that of the tide clock, added switches -mllw and -fgmllw, and provided code to calibrate the depth marks with MLLW. Messed with the calibrated tick mark code, then made it the default. Also stopped tick marks from clobbering text. Removed year from dates in skinny mode (graph and text). Integrated Rob's Ultrix compatibility patch. Added a bunch of asserts to the argument parsing code. Added the -ppm switch (one huge hack). Usage info now goes to stderr. Jef implemented ASCII graph mode and partially calibrated the tick marks with the top of the hour. Finished it, made it the default. Fixed an off-by-one error in ASCII graph mode and rounded everything. Made -mark and -middle different colors. Ooops -- I broke the tick marks in other timezones. Fixed. Removed non-sig-digs from tide heights printed in text mode. Changed __svr4__ to SVR4 in #ifdefs because it wasn't working right on some version of Solaris. Added (int) cast to strlen returns to silence compiler warnings on Solaris. Enhanced -mark to show times when mark level is crossed. Corrected an old bug that has been causing all the tide predictions to be late by 1 minute. Hourly tick marks that mark day boundaries are thicker. Labeled the PPM with the location. Added a switch to change its size. The special case code for mark transitions and tides at the same time had an off-by-one error. Fixed. Closed the interval used to detect mark transitions. Fixed day marks for DST changes. Patch 1 to 1.1, 8/27/95: Fixed a possible robustness problem that was introduced in 1.1 when I tried to get the high and low tide predictions in the tide clock always to update at the same time that the water changed color. There was the potential for the tides to get permanently out of synchronization with the current time after a localized disturbance such as a change of epoch or resetting the system clock. Version 1.1, 8/26/95: Next low tide is now displayed at the bottom of the window. Fixed the bug that was causing off-by-one-pixel errors in window updates. Added -middle, -now, -skinny, and -text switches. Changed matching of locations specified on the command line to have more slack. It's now case-insensitive, and you only need to type enough letters to uniquely identify the location that you want. No more core dumps on assertion failures. Assorted cleanups and nit fixes, but mainly just more spaghetti code for your reading enjoyment. Patch 2 to 1.0, 8/16/95: Fixed two bugs that compensated in such a way that locations in the current time zone worked fine. For locations in other time zones, the timestamps were totally wrong. Time displacements of the form -HH:MM, where MM was nonzero, were being processed incorrectly. Fixed. Patch 1 to 1.0, 8/5/95: Fixed a potential underflow error that affected New Year's Day only, and only on machines where time_t is unsigned. Version 1.0 released locally on 8/4/95.